Skip to content

Added CheerpJ extension docs (Debug & File handling)#375

Open
rijulshrestha wants to merge 11 commits intomainfrom
CheerpJ-Extension-Docs
Open

Added CheerpJ extension docs (Debug & File handling)#375
rijulshrestha wants to merge 11 commits intomainfrom
CheerpJ-Extension-Docs

Conversation

@rijulshrestha
Copy link
Copy Markdown
Contributor

@rijulshrestha rijulshrestha commented Mar 26, 2026

No description provided.

@rijulshrestha rijulshrestha requested a review from epanholz March 26, 2026 12:17
@rijulshrestha rijulshrestha self-assigned this Mar 26, 2026
@epanholz
Copy link
Copy Markdown
Member

epanholz commented Mar 26, 2026

Great job already! The overall flow of the new pages is really nice and they are not too overloaded.

Debug page input:

  • I am not to happy with the title, something like "How to debug the extension" might be better
  • Please prompt users to enable the debug setting before loading the application or to reload the page after enabling the setting. Otherwise it won't take effect.
  • Please include the instructions on how to collect a console log and har file in the extension pages. Clicking to another page is annoying for users. And we need to add specific instructions for each extension. For the JNLPRunner we can prompt users to open the dev tools on the "start application" page. To make sure the logs are complete. And for the AppletRunner we need to prompt users to either reload the page after opening the dev tools or to enable the extension only after the dev tools are open. This helps with getting incomplete logs from users. It's a bit annoying that we will have such similar pages, but it can help us save some time in the long run.

File pages:

  • We can link to the explanation guide here at the top of the page
  • For the upload button we should add context that it will only be available once an applet/application is already running
  • We can also add that if users can't see the popup icon they need to ping the extension
  • Please remove mentions of JFileChooser, there is other classes that work the same. We can just mention it once like this "Java File Dialog (for example JFileChooser) and then just say File Dialog. Also the upload icon will be present on any window/frame/dialog that opens. It's part of the title bar.

GabrielaReyna
GabrielaReyna requested changes Apr 1, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@GabrielaReyna GabrielaReyna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some extra suggestions with vocabulary to avoid confusion between the local filesystem and the virtual one. More than that, very good.

Comment thread sites/labs/src/content/docs/cheerpj-applet-runner/04-guides/file-handling.mdx Outdated
Comment thread sites/labs/src/content/docs/cheerpj-applet-runner/04-guides/file-handling.mdx Outdated
Comment thread sites/labs/src/content/docs/cheerpj-applet-runner/04-guides/file-handling.mdx Outdated
Comment thread sites/labs/src/content/docs/cheerpj-jnlp-runner/04-guides/file-handling.mdx Outdated
Comment thread sites/labs/src/content/docs/cheerpj-jnlp-runner/04-guides/file-handling.mdx Outdated
Comment thread sites/labs/src/content/docs/cheerpj-jnlp-runner/04-guides/file-handling.mdx Outdated
epanholz
epanholz requested changes Apr 20, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@epanholz epanholz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should add a more general section at the start of the debug docs that describe how to verify if the extension is working or not.

For the AppletRunner:

  • Is the extension pinged?
  • Is the extension enabled?
  • Is there an Applet and does it start?
  • Network errors?

Everything above works as it should, reach out to use so we can help and provide these logs -> Enable debug mode and collect logs

For the JNLPRunner:

  • Extensions enabled?
  • Correct extension?
  • Start page?
  • JNLP File gets download instead of start page shows -> use drag and drop to test

Everything above works as it should, reach out to use so we can help and provide these logs -> Enable debug mode and collect logs

Feel free to add anything else you might think could be useful and help users

The structure of the file handling file is a bit confusing. There is a lot of repeating sections and headers with similar titles. I think we just need 3 sections, introductions, uploads and downloads.

Comment thread sites/labs/src/content/docs/cheerpj-applet-runner/04-guides/file-handling.mdx Outdated
Comment on lines +33 to +35
## Method 2: Using the built-in file picker

If the Java applet uses a standard Java File Dialog (for example, `JFileChooser`), CheerpJ provides an integrated way to handle local files without leaving the applet's UI.
Copy link
Copy Markdown
Member

@epanholz epanholz Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sections should be called something like Using the window title bar

Then explain then windows/frames/dialogs that have a title bar will have a new upload icon. The main Applet frame is normally undercoated, meaning it has no title bar, so mentioning file dialogs and extra windows is useful here.

@rijulshrestha rijulshrestha requested a review from epanholz April 20, 2026 16:55
epanholz
epanholz requested changes Apr 21, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@epanholz epanholz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left two more small comments for the file system docs.
For the debug page: Please add a URL to our discord and the github issues page for the extensions so users know how they can reach out to us.

The rest looks good to me. Please go ahead and remove the JNLPRunner docs so we can merge the AppletRunner version for now. Please also add some screenshots to the AppletRunner docs of the debug option and the file upload button.

Comment thread sites/labs/src/content/docs/cheerpj-applet-runner/04-guides/file-handling.mdx
Comment thread sites/labs/src/content/docs/cheerpj-applet-runner/04-guides/file-handling.mdx Outdated
@rijulshrestha rijulshrestha force-pushed the CheerpJ-Extension-Docs branch from e56be23 to 53145e3 Compare April 22, 2026 09:04
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Apr 22, 2026 •
edited
Loading

Deploying labs-browserpod-previews with  Cloudflare Pages  Cloudflare Pages

Latest commit: 53145e3
Status: ✅  Deploy successful!
Preview URL: https://351b84b7.labs-browserpod-previews.pages.dev
Branch Preview URL: https://cheerpj-jnlp-docs.labs-browserpod-previews.pages.dev

View logs

@rijulshrestha rijulshrestha requested a review from epanholz April 22, 2026 09:12
@rijulshrestha
Copy link
Copy Markdown
Contributor Author

rijulshrestha commented Apr 22, 2026

I've removed the JNLP Runner Extension docs from here and created another branch cheerpj-jnlp-docs and moved them there.

@rijulshrestha rijulshrestha marked this pull request as ready for review April 22, 2026 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@GabrielaReyna GabrielaReyna GabrielaReyna requested changes

@epanholz epanholz Awaiting requested review from epanholz

Requested changes must be addressed to merge this pull request.

Assignees

@rijulshrestha rijulshrestha

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rijulshrestha @epanholz @GabrielaReyna